FHIR © HL7.org  |  Server Home  |  FHIR Server FHIR Server 3.4.11  |  FHIR Version n/a  User: [n/a]

Resource OperationDefinition/FHIR Server from package hl7.fhir.us.davinci-atr#current (47 ms)

Package hl7.fhir.us.davinci-atr
Type OperationDefinition
Id Id
FHIR Version R4
Source http://hl7.org/fhir/us/davinci-atr/https://build.fhir.org/ig/HL7/davinci-atr/OperationDefinition-davinci-data-export.html
Url http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export
Version 2.1.0-preview
Status active
Date 2021-07-22T21:48:56+10:00
Name DaVinciDataExport
Title DaVinci Data Export
Experimental False
Realm us
Authority hl7
Description Exports data about members of the Group
Type false
Kind operation

Resources that use this resource

CapabilityStatement
http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-payer-access-server PDex Payer Access Server CapabilityStatement
http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-provider-access-server PDex Provider Access Server CapabilityStatement
http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-server-6-1 PDex Server CapabilityStatement with US core 6.1 support
http://hl7.org/fhir/us/davinci-pdex/CapabilityStatement/pdex-server PDEX Server CapabilityStatement

Resources that this resource uses

No resources found



Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: OperationDefinition davinci-data-export

URL: [base]/Group/[id]/$davinci-data-export

Parameters

UseNameScopeCardinalityTypeBindingDocumentation
INpatient0..*Reference

The Members whose data has to be exported, when omitted the data about all members in the Group should be exported. The references are pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group. For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.

INexportType0..1canonical

The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export, and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.

IN_since0..1instant

Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation.

IN_until0..1instant

Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.

IN_type0..1string

The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation.

IN_typeFilter0..1string

The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.


Source

{
  "resourceType" : "OperationDefinition",
  "id" : "davinci-data-export",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition davinci-data-export</b></p><a name=\"davinci-data-export\"> </a><a name=\"hcdavinci-data-export\"> </a><a name=\"davinci-data-export-en-US\"> </a><p>URL: [base]/Group/[id]/$davinci-data-export</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>patient</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a></td><td/><td><div><p>The Members whose data has to be exported, when omitted the data about all members in the Group should be exported. The references are pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group. For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.</p>\n</div></td></tr><tr><td>IN</td><td>exportType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#canonical\">canonical</a></td><td/><td><div><p>The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export, and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.</p>\n</div></td></tr><tr><td>IN</td><td>_since</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation.</p>\n</div></td></tr><tr><td>IN</td><td>_until</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#instant\">instant</a></td><td/><td><div><p>Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.</p>\n</div></td></tr><tr><td>IN</td><td>_type</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation.</p>\n</div></td></tr><tr><td>IN</td><td>_typeFilter</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#string\">string</a></td><td/><td><div><p>The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.</p>\n</div></td></tr></table></div>"
  },
  "extension" : [
    {
      "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
      "valueCode" : "fm"
    }
  ],
  "url" : "http://hl7.org/fhir/us/davinci-atr/OperationDefinition/davinci-data-export",
  "version" : "2.1.0-preview",
  "name" : "DaVinciDataExport",
  "title" : "DaVinci Data Export",
  "status" : "active",
  "kind" : "operation",
  "date" : "2021-07-22T21:48:56+10:00",
  "publisher" : "HL7 International / Financial Management",
  "contact" : [
    {
      "telecom" : [
        {
          "system" : "url",
          "value" : "http://www.hl7.org/Special/committees/fm"
        }
      ]
    }
  ],
  "description" : "Exports data about members of the Group",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "US"
        }
      ]
    }
  ],
  "code" : "davinci-data-export",
  "base" : "http://hl7.org/fhir/uv/bulkdata/OperationDefinition/group-export",
  "resource" : [
    "Group"
  ],
  "system" : false,
  "type" : false,
  "instance" : true,
  "parameter" : [
    {
      "name" : "patient",
      "use" : "in",
      "min" : 0,
      "max" : "*",
      "documentation" : "The Members whose data has to be exported, when omitted the data about all members in the Group should be exported. The references are pointing to resources in the FHIR Server supporting the davinci-data-export operation. The server will ignore invalid references to patients or if the patients are not part of the Group. For each member that is invalid or ignored an operation outcome has to be returned detailing the specific error.This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.",
      "type" : "Reference"
    },
    {
      "name" : "exportType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The code that indicates the type of export to be performed. For e.g hl7.fhir.us.davinci-atr to indicate Member Attribution export, and hl7.fhir.us.davinci-pdex for a PDex Export. Servers are supposed to provide the export guidance in the individual IGs. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.",
      "type" : "canonical"
    },
    {
      "name" : "_since",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Resources updated after the specified time will be included in the response. When omitted, the Server is free to export all data for the members. This parameter is exactly the same parameter defined in the Bulk Data Export operation.",
      "type" : "instant"
    },
    {
      "name" : "_until",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Resources updated before the specified time will be included in the response. When omitted, the Server is free to export all data for the members until the time the export operation is started. This is a new parameter added to the operation that is not present in the Bulk Data Export operation.",
      "type" : "instant"
    },
    {
      "name" : "_type",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The resources that need to be extracted for the patients. This is a string of comma-delimited FHIR resource types. This is the same parameter defined in the Bulk Data Export operation specification. This parameter is exactly the same parameter defined in the Bulk Data Export operation.",
      "type" : "string"
    },
    {
      "name" : "_typeFilter",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "The list of Queries that need to be executed for the resources to be exported. This will allow the consumer to limit the data being exported. This is a string of comma delimited FHIR REST queries. This parameter is exactly the same parameter defined in the latest Bulk Data Export operation.",
      "type" : "string"
    }
  ]
}

XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.